//
// ITextEditorImpl.cs
//
// Author:
//       Mike Krüger <mkrueger@xamarin.com>
//
// Copyright (c) 2014 Xamarin Inc. (http://xamarin.com)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
using System;
using System.Collections.Generic;

namespace MonoDevelop.Ide.Editor
{
	public enum TextLinkPurpose
	{
		Unknown,
		Rename
	}

	/// <summary>
	/// This class contains information the editor needs to initiate the text link mode.
	/// </summary>
	public sealed class TextLinkModeOptions
	{
		/// <summary>
		/// The text links. Note that this property will change to IReadOnlyList in future versions.
		/// </summary>
		public IList<TextLink> Links { 
			get;
			private set;
		}

		/// <summary>
		/// That's the action that is started after the text link mode ended.
		/// This may be null (in that case no action is started). 
		/// </summary>
		public Action<TextLinkModeEventArgs> ModeExitedAction {
			get;
			private set;
		}

		public TextLinkPurpose TextLinkPurpose { get; set; }

		/// <summary>
		/// Initializes a new instance of the <see cref="MonoDevelop.Ide.Editor.TextLinkModeOptions"/> class.
		/// </summary>
		/// <param name="links">The text links. </param>
		/// <param name="modeExitedAction">That's the action that is started after the text link mode ended.</param>
		public TextLinkModeOptions (IList<TextLink> links, Action<TextLinkModeEventArgs> modeExitedAction = null)
		{
			if (links == null)
				throw new ArgumentNullException ("links");
			Links = links;
			ModeExitedAction = modeExitedAction;
		}
	}
}